<!DOCTYPE html>
<html>
  <head>
    <meta charset='utf-8'>
    <meta content='width=device-width, initial-scale=1.0' name='viewport'>
    <meta content='' name='description'>
    <meta content='Nils Nordman' name='author'>
    <link href='/images/howl.png' rel='shortcut icon'>
    <title>Howl :: Spec - howl.command</title>
    <link href="/stylesheets/bootstrap.min.css" media="screen" rel="stylesheet" type="text/css" />
    <link href="/stylesheets/syntax.css" media="screen" rel="stylesheet" type="text/css" />
    <link href="/stylesheets/howl.css" media="screen" rel="stylesheet" type="text/css" />
    <script src="https://code.jquery.com/jquery-1.12.3.min.js" type="text/javascript"></script>
    <script src="/javascripts/bootstrap.min.js" type="text/javascript"></script>
    
    <link href='//fonts.googleapis.com/css?family=Josefin+Slab' rel='stylesheet' type='text/css'>
    <link href='//fonts.googleapis.com/css?family=Open+Sans+Condensed:700' rel='stylesheet' type='text/css'>
  </head>
  <body class='doc doc_spec doc_spec_command_spec'>
    <div class='container'>
      <div class='masthead'>
        <ul class='nav nav-pills'>
          <li>
            <a href='/'>
              <span class='glyphicon glyphicon-home'></span>
              Home
            </a>
          </li>
          <li>
            <a href='/doc/'>
              <span class='glyphicon glyphicon-book'></span>
              Documentation
            </a>
          </li>
          <li>
            <a href='/blog/'>
              <span class='glyphicon glyphicon-bullhorn'></span>
              Blog
            </a>
          </li>
          <li>
            <a href='/contact.html'>
              <span class='glyphicon glyphicon-inbox'></span>
              Contact
            </a>
          </li>
        </ul>
      </div>
      <ol class="breadcrumb"><li><a href="/">Home</a></li><li><a href='../'>Howl 0.4 Documentation</a></li><li>Spec</li><li>Spec - howl.command</li></ol>
      <div class="spec-group spec-group-1">&#x000A;&#x000A;<h1 id="howl.command">howl.command</h1>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="kd">local</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">run</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="o">...</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">f</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">coroutine.wrap</span><span class="w"> </span><span class="p">(</span><span class="o">...</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">run</span><span class="w"> </span><span class="o">...</span><span class="w">&#x000A;  </span><span class="n">f</span><span class="w"> </span><span class="o">...</span><span class="w">&#x000A;&#x000A;</span><span class="n">before_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Window</span><span class="o">!</span><span class="w">&#x000A;  </span><span class="n">cmd</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'foo'</span><span class="p">,</span><span class="w"> </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'desc'</span><span class="p">,</span><span class="w"> </span><span class="ss">handler:</span><span class="w"> </span><span class="n">spy</span><span class="p">.</span><span class="n">new</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s1">'foo-result'</span><span class="w">&#x000A;&#x000A;</span><span class="n">after_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">nil</span><span class="w">&#x000A;  </span><span class="n">command</span><span class="p">.</span><span class="n">unregister</span><span class="w"> </span><span class="n">name</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">name</span><span class="w"> </span><span class="k">in</span><span class="w"> </span><span class="o">*</span><span class="n">command</span><span class="p">.</span><span class="n">names</span><span class="o">!</span></pre>&#x000A;&#x000A;<h4 id=".names()-returns-a-list-of-all-command-names">.names() returns a list of all command names</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">includes</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">names</span><span class="o">!</span><span class="p">,</span><span class="w"> </span><span class="s1">'foo'</span></pre>&#x000A;&#x000A;<h4 id=".get(name)-returns-the-command-with-the-specified-name">.get(name) returns the command with the specified name</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equal</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'foo'</span><span class="p">).</span><span class="n">handler</span><span class="p">,</span><span class="w"> </span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span></pre>&#x000A;&#x000A;<h4 id="calling-.&lt;name&gt;(args)-invokes-command,-passing-arguments">calling .&lt;name&gt;(args) invokes command, passing arguments</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">command</span><span class="p">.</span><span class="n">foo</span><span class="p">(</span><span class="s1">'arg1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg2'</span><span class="p">)</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called</span><span class="w"> </span><span class="mi">1</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called_with</span><span class="w"> </span><span class="s1">'arg1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg2'</span></pre>&#x000A;&#x000A;<h4 id=".unregister(command)-removes-the-command-and-any-aliases">.unregister(command) removes the command and any aliases</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">command</span><span class="p">.</span><span class="n">alias</span><span class="w"> </span><span class="s1">'foo'</span><span class="p">,</span><span class="w"> </span><span class="s1">'bar'</span><span class="w">&#x000A;</span><span class="n">command</span><span class="p">.</span><span class="n">unregister</span><span class="w"> </span><span class="s1">'foo'</span><span class="w">&#x000A;&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">is_nil</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">foo</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">is_nil</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">bar</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">same</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">names</span><span class="o">!</span><span class="p">,</span><span class="w"> </span><span class="p">{}</span></pre>&#x000A;<div class="spec-group spec-group-2">&#x000A;&#x000A;<h2 id=".register">.register<span class="arg-list">(command)</span></h2>&#x000A;&#x000A;<h4 id="raises-an-error-if-any-of-the-mandatory-fields-are-missing">raises an error if any of the mandatory fields are missing</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">assert</span><span class="p">.</span><span class="n">raises</span><span class="w"> </span><span class="s1">'name'</span><span class="p">,</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="p">{}</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">raises</span><span class="w"> </span><span class="s1">'description'</span><span class="p">,</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'foo'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">raises</span><span class="w"> </span><span class="s1">'handler'</span><span class="p">,</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'foo'</span><span class="p">,</span><span class="w"> </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'do'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">raises</span><span class="w"> </span><span class="s1">'factory'</span><span class="p">,</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'foo'</span><span class="p">,</span><span class="w"> </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'do'</span></pre>&#x000A;</div>&#x000A;<div class="spec-group spec-group-2">&#x000A;&#x000A;<h2 id=".alias">.alias<span class="arg-list">(target, name)</span></h2>&#x000A;&#x000A;<h4 id="raises-an-error-if-target-does-not-exist">raises an error if target does not exist</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">assert</span><span class="p">.</span><span class="n">raises</span><span class="w"> </span><span class="s1">'exist'</span><span class="p">,</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">alias</span><span class="w"> </span><span class="s1">'nothing'</span><span class="p">,</span><span class="w"> </span><span class="s1">'something'</span></pre>&#x000A;&#x000A;<h4 id="allows-for-multiple-names-for-the-same-command">allows for multiple names for the same command</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">command</span><span class="p">.</span><span class="n">alias</span><span class="w"> </span><span class="s1">'foo'</span><span class="p">,</span><span class="w"> </span><span class="s1">'bar'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equal</span><span class="w"> </span><span class="s1">'foo'</span><span class="p">,</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'bar'</span><span class="p">).</span><span class="n">alias_for</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">includes</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">names</span><span class="o">!</span><span class="p">,</span><span class="w"> </span><span class="s1">'bar'</span></pre>&#x000A;</div>&#x000A;<div class="spec-group spec-group-2">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(when command name is a non-lua identifier)</span></h3>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">before_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">cmd</span><span class="p">.</span><span class="n">name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'foo-cmd:bar'</span></pre>&#x000A;&#x000A;<h4 id="register()-adds-accessible-aliases">register() adds accessible aliases</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">not_nil</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">foo_cmd_bar</span></pre>&#x000A;&#x000A;<h4 id="the-accessible-alias-is-not-part-of-names()">the accessible alias is not part of names()</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">same</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">names</span><span class="o">!</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s1">'foo-cmd:bar'</span><span class="w"> </span><span class="p">}</span></pre>&#x000A;&#x000A;<h4 id="calling-.&lt;accessible_name&gt;(args)-invokes-command,-passing-arguments">calling .&lt;accessible_name&gt;(args) invokes command, passing arguments</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">dispatch</span><span class="p">.</span><span class="n">launch</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">foo_cmd_bar</span><span class="p">(</span><span class="s1">'arg1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg2'</span><span class="p">)</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called</span><span class="w"> </span><span class="mi">1</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called_with</span><span class="w"> </span><span class="s1">'arg1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg2'</span></pre>&#x000A;&#x000A;<h4 id="unregister()-removes-the-accessible-name-as-well">unregister() removes the accessible name as well</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">command</span><span class="p">.</span><span class="n">unregister</span><span class="w"> </span><span class="s1">'foo-cmd:bar'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">is_nil</span><span class="w"> </span><span class="n">command</span><span class="p">.</span><span class="n">foo_cmd_bar</span></pre>&#x000A;</div>&#x000A;<div class="spec-group spec-group-2">&#x000A;&#x000A;<h2 id=".run">.run<span class="arg-list">(cmd_string)</span></h2>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(when &lt;cmd_string&gt; is empty or missing)</span></h3>&#x000A;&#x000A;<h4 id="displays-the-commandline-with-a-&quot;:&quot;-prompt">displays the commandline with a &quot;:&quot; prompt</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">run</span><span class="o">!</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">':'</span><span class="p">,</span><span class="w"> </span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="p">.</span><span class="n">command_line</span><span class="p">.</span><span class="n">prompt</span></pre>&#x000A;</div>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(when &lt;cmd_string&gt; is given)</span></h3>&#x000A;<div class="spec-group spec-group-4">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(..  and it matches a command)</span></h3>&#x000A;&#x000A;<h4 id="that-command-is-invoked">that command is invoked</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">run</span><span class="w"> </span><span class="n">cmd</span><span class="p">.</span><span class="n">name</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called</span><span class="w"> </span><span class="mi">1</span></pre>&#x000A;<div class="spec-group spec-group-5">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(..  and the command specifies an input function)</span></h3>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="kd">local</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;&#x000A;</span><span class="n">before_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">cmd</span><span class="w"> </span><span class="o">=</span><span class="w">&#x000A;    </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'with-input'</span><span class="w">&#x000A;    </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'test'</span><span class="w">&#x000A;    </span><span class="ss">input:</span><span class="w"> </span><span class="n">spy</span><span class="p">.</span><span class="n">new</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="s1">'input-result1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'input-result2'</span><span class="w">&#x000A;    </span><span class="ss">handler:</span><span class="w"> </span><span class="n">spy</span><span class="p">.</span><span class="n">new</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span></pre>&#x000A;&#x000A;<h4 id="calls-the-command-input-function,-passing-through-extra-args">calls the command input function, passing through extra args</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">run</span><span class="w"> </span><span class="n">cmd</span><span class="p">.</span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg2'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">input</span><span class="p">).</span><span class="n">was_called</span><span class="w"> </span><span class="mi">1</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">input</span><span class="p">).</span><span class="n">was_called_with</span><span class="w"> </span><span class="s1">'arg1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg2'</span></pre>&#x000A;&#x000A;<h4 id="passes-the-result-of-the-input-function-into-the-handler">passes the result of the input function into the handler</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">run</span><span class="w"> </span><span class="n">cmd</span><span class="p">.</span><span class="n">name</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called</span><span class="w"> </span><span class="mi">1</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called_with</span><span class="w"> </span><span class="s1">'input-result1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'input-result2'</span></pre>&#x000A;&#x000A;<h4 id="does-not-call-handler-if-input-function-returns-nil">does not call handler if input function returns nil</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">cmd</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w">&#x000A;  </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'cancelled-input'</span><span class="w">&#x000A;  </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'test'</span><span class="w">&#x000A;  </span><span class="ss">input:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="ss">handler:</span><span class="w"> </span><span class="n">spy</span><span class="p">.</span><span class="n">new</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;</span><span class="p">}</span><span class="w">&#x000A;</span><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">run</span><span class="w"> </span><span class="n">cmd</span><span class="p">.</span><span class="n">name</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called</span><span class="w"> </span><span class="mi">0</span></pre>&#x000A;&#x000A;<h4 id="sets-spillover-to-any-text-arguments-before-invoking-the-input">sets spillover to any text arguments before invoking the input</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="kd">local</span><span class="w"> </span><span class="n">spillover</span><span class="w">&#x000A;</span><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w">&#x000A;  </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'with-input'</span><span class="w">&#x000A;  </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'test'</span><span class="w">&#x000A;  </span><span class="ss">input:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">spillover</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="p">.</span><span class="n">command_line</span><span class="o">\</span><span class="n">pop_spillover</span><span class="o">!</span><span class="w">&#x000A;  </span><span class="ss">handler:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;</span><span class="n">run</span><span class="w"> </span><span class="s1">'with-input hello cmd'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equal</span><span class="w"> </span><span class="s1">'hello cmd'</span><span class="p">,</span><span class="w"> </span><span class="n">spillover</span></pre>&#x000A;&#x000A;<h4 id="displays-the-&quot;:&lt;cmd_string&gt;-&quot;-in-the-command-line-during-input">displays the &quot;:&lt;cmd_string&gt; &quot; in the command line during input</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="kd">local</span><span class="w"> </span><span class="n">prompt</span><span class="w">&#x000A;</span><span class="n">cmd</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w">&#x000A;  </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'getp'</span><span class="w">&#x000A;  </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'desc'</span><span class="w">&#x000A;  </span><span class="ss">input:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">prompt</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="p">.</span><span class="n">command_line</span><span class="p">.</span><span class="n">command_widget</span><span class="p">.</span><span class="n">text</span><span class="w">&#x000A;  </span><span class="ss">handler:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;</span><span class="p">}</span><span class="w">&#x000A;</span><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">run</span><span class="w"> </span><span class="s1">'getp'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">':'</span><span class="o">..</span><span class="n">cmd</span><span class="p">.</span><span class="n">name</span><span class="o">..</span><span class="s1">' '</span><span class="p">,</span><span class="w"> </span><span class="n">prompt</span></pre>&#x000A;</div>&#x000A;<div class="spec-group spec-group-5">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(..  and the command does not specify an input function)</span></h3>&#x000A;&#x000A;<h4 id="calls-the-command-handler,-passing-through-extra-args">calls the command handler, passing through extra args</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">cmd</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w">&#x000A;  </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'without-input'</span><span class="w">&#x000A;  </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'test'</span><span class="w">&#x000A;  </span><span class="ss">handler:</span><span class="w"> </span><span class="n">spy</span><span class="p">.</span><span class="n">new</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;</span><span class="p">}</span><span class="w">&#x000A;</span><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">run</span><span class="w"> </span><span class="n">cmd</span><span class="p">.</span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg2'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called</span><span class="w"> </span><span class="mi">1</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called_with</span><span class="w"> </span><span class="s1">'arg1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg2'</span></pre>&#x000A;</div>&#x000A;</div>&#x000A;<div class="spec-group spec-group-4">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(..  and it matches an alias)</span></h3>&#x000A;&#x000A;<h4 id="the-aliased-command-is-invoked">the aliased command is invoked</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span><span class="w">&#x000A;</span><span class="n">command</span><span class="p">.</span><span class="n">alias</span><span class="w"> </span><span class="n">cmd</span><span class="p">.</span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="s1">'aliascmd'</span><span class="w">&#x000A;</span><span class="n">run</span><span class="w"> </span><span class="s1">'aliascmd'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">cmd</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called</span><span class="w"> </span><span class="mi">1</span></pre>&#x000A;</div>&#x000A;<div class="spec-group spec-group-4">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(..  and it contains &lt;non-interactive-command&gt;space&lt;args&gt;)</span></h3>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">before_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">log</span><span class="p">.</span><span class="n">clear</span><span class="o">!</span><span class="w">&#x000A;  </span><span class="n">command</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">cmd</span></pre>&#x000A;&#x000A;<h4 id="logs-an-error">logs an error</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">run</span><span class="w"> </span><span class="n">cmd</span><span class="p">.</span><span class="n">name</span><span class="w"> </span><span class="o">..</span><span class="w"> </span><span class="s1">' args'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">not_nil</span><span class="w"> </span><span class="n">log</span><span class="p">.</span><span class="n">last_error</span></pre>&#x000A;&#x000A;<h4 id="the-command-line-contains-the-command-name">the command line contains the command name</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">run</span><span class="w"> </span><span class="n">cmd</span><span class="p">.</span><span class="n">name</span><span class="w"> </span><span class="o">..</span><span class="w"> </span><span class="s1">' args'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="n">cmd</span><span class="p">.</span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="p">.</span><span class="n">command_line</span><span class="p">.</span><span class="n">text</span></pre>&#x000A;</div>&#x000A;<div class="spec-group spec-group-4">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(..  and it contains &lt;invalid-command&gt;space&lt;args&gt;)</span></h3>&#x000A;&#x000A;<h4 id="logs-an-error">logs an error</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">run</span><span class="w"> </span><span class="s1">'no-such-command hello cmd'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">not_nil</span><span class="w"> </span><span class="n">log</span><span class="p">.</span><span class="n">last_error</span></pre>&#x000A;&#x000A;<h4 id="the-command-line-contains-the-passed-text">the command line contains the passed text</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">run</span><span class="w"> </span><span class="s1">'no-such-command hello cmd'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">'no-such-command hello cmd'</span><span class="p">,</span><span class="w"> </span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="p">.</span><span class="n">command_line</span><span class="p">.</span><span class="n">text</span></pre>&#x000A;</div>&#x000A;<div class="spec-group spec-group-4">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(..  when it specifies a unknown command)</span></h3>&#x000A;&#x000A;<h4 id="displays-the-&lt;cmd_string&gt;-in-the-commandline-text">displays the &lt;cmd_string&gt; in the commandline text</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">run</span><span class="w"> </span><span class="s1">'what-the-heck now'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">'what-the-heck now'</span><span class="p">,</span><span class="w"> </span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="p">.</span><span class="n">command_line</span><span class="p">.</span><span class="n">text</span></pre>&#x000A;</div>&#x000A;</div>&#x000A;</div>&#x000A;</div>
      <div class='footer text-muted'>
        <a href='/'>
          <img width="50" height="50" class="footer-logo" src="/images/howl.png" />
        </a>
        <div class='footer-follow'>
          <p>
            <a class='twitter-follow-button' data-lang='en' data-show-count='false' href='https://twitter.com/howleditor' rel='me'>
              Follow @howleditor
            </a>
          </p>
          <p>
            <a class='twitter-share-button' data-count='none' data-hashtags='howleditor' data-lang='en' data-text='The Howl Editor, a general purpose, light-weight customizable editor.' data-url='http://howl.io' href='https://twitter.com/share'>
              Tweet
            </a>
          </p>
        </div>
        <div class='footer-blurb'>
          <div>The Howl editor.</div>
          <div>
            Copyright 2012-2016
            <a class='alert-link' href='https://github.com/howl-editor/howl/contributors'>
              The Howl Developers.
            </a>
          </div>
        </div>
      </div>
    </div>
    <script>
      <!-- / GA -->
      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
      ga('create', 'UA-45283282-1', 'howl.io');
      ga('send', 'pageview');
      <!-- / Twitter -->
      !function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];
      if(!d.getElementById(id)){js=d.createElement(s);js.id=id;
      js.src="//platform.twitter.com/widgets.js";
      fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");
    </script>
  </body>
</html>
